/* Copyright 2018-2023 The TensorFlow Authors. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
=======================================================================*/

// This class has been generated, DO NOT EDIT!

package org.tensorflow.op.train;

import java.util.Arrays;
import org.tensorflow.GraphOperation;
import org.tensorflow.Operand;
import org.tensorflow.Operation;
import org.tensorflow.OperationBuilder;
import org.tensorflow.Output;
import org.tensorflow.op.RawOp;
import org.tensorflow.op.RawOpInputs;
import org.tensorflow.op.Scope;
import org.tensorflow.op.annotation.Endpoint;
import org.tensorflow.op.annotation.OpInputsMetadata;
import org.tensorflow.op.annotation.OpMetadata;
import org.tensorflow.op.annotation.Operator;
import org.tensorflow.proto.DataType;
import org.tensorflow.types.TInt32;
import org.tensorflow.types.family.TType;

/**
 * Returns the gradient of {@code Tile}.
 * Since {@code Tile} takes an input and repeats the input {@code multiples} times
 * along each dimension, {@code train.TileGrad} takes in {@code multiples} and aggregates
 * each repeated tile of {@code input} into {@code output}.
 *
 * @param <T> data type for {@code output} output
 */
@OpMetadata(
    opType = TileGrad.OP_NAME,
    inputsClass = TileGrad.Inputs.class
)
@Operator(
    group = "train"
)
public final class TileGrad<T extends TType> extends RawOp implements Operand<T> {
  /**
   * The name of this op, as known by TensorFlow core engine
   */
  public static final String OP_NAME = "TileGrad";

  private Output<T> output;

  public TileGrad(Operation operation) {
    super(operation, OP_NAME);
    int outputIdx = 0;
    output = operation.output(outputIdx++);
  }

  /**
   * Factory method to create a class wrapping a new TileGrad operation.
   *
   * @param scope current scope
   * @param input The input value
   * @param multiples The multiples value
   * @param <T> data type for {@code TileGrad} output and operands
   * @return a new instance of TileGrad
   */
  @Endpoint(
      describeByClass = true
  )
  public static <T extends TType> TileGrad<T> create(Scope scope, Operand<T> input,
      Operand<TInt32> multiples) {
    OperationBuilder opBuilder = scope.opBuilder(OP_NAME, "TileGrad");
    opBuilder.addInput(input.asOutput());
    opBuilder.addInput(multiples.asOutput());
    return new TileGrad<>(opBuilder.build());
  }

  /**
   * Gets output.
   *
   * @return output.
   */
  public Output<T> output() {
    return output;
  }

  @Override
  public Output<T> asOutput() {
    return output;
  }

  @OpInputsMetadata(
      outputsClass = TileGrad.class
  )
  public static class Inputs<T extends TType> extends RawOpInputs<TileGrad<T>> {
    /**
     * The input input
     */
    public final Operand<T> input;

    /**
     * The multiples input
     */
    public final Operand<TInt32> multiples;

    /**
     * The T attribute
     */
    public final DataType T;

    public Inputs(GraphOperation op) {
      super(new TileGrad<>(op), op, Arrays.asList("T"));
      int inputIndex = 0;
      input = (Operand<T>) op.input(inputIndex++);
      multiples = (Operand<TInt32>) op.input(inputIndex++);
      T = op.attributes().getAttrType("T");
    }
  }
}
